refactor(Html2Image): update Html2Image extension package #5426

ArgoZhang · 2025-02-22T14:56:32Z

update Html2Image extension package

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5425

Regression?

Yes
No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

High
Medium
Low

[Justify the selection above]

Verification

Manual (required)
Automated

Packaging changes reviewed?

Yes
No
N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

Doc is updated/provided or not needed
Demo is updated/provided or not needed
Merge the latest code from the main branch

Summary by Sourcery

Refactors the Html2Image service to improve error handling and provide guidance to users on how to install and register the required dependency. The service now throws an exception if the BootstrapBlazor.Html2Image package is not installed, and the API is updated to use an interface for the options.

Bug Fixes:

Fixes issue where the Html2Image service was not working correctly due to a missing dependency. The service now throws an exception if the required package is not installed, guiding users to add the necessary dependency.

Enhancements:

Updates the Html2Image service to throw a NotImplementedException with a message that instructs the user to install the BootstrapBlazor.Html2Image package and register the service using AddBootstrapBlazorHtml2ImageService.
Updates the GetDataAsync and GetStreamAsync methods in DefaultHtml2ImageService to accept an optional IHtml2ImageOptions parameter, providing more flexibility in configuring the image export.

Tests:

Adds a unit test to verify that the Html2Image service throws a NotImplementedException when the required dependency is missing.

Co-Authored-By: ElanCao <[email protected]>

sourcery-ai · 2025-02-22T14:56:36Z

Reviewer's Guide by Sourcery

This PR updates the Html2Image extension package. The main changes include removing the default implementation of the IHtml2Image service, updating the Html2Images sample page, adding an interface for Html2Image options, adding a unit test, and removing the javascript files related to the html2image library. The changes enforce that the user must install the BootstrapBlazor.Html2Image package to use the Html2Image functionality.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Removes the implementation of the `IHtml2Image` service and throws `NotImplementedException` with a message indicating that the `BootstrapBlazor.Html2Image` package needs to be added and the service injected.	Removes the `_jsModule` field. Removes the `Execute` and `ToBlob` methods. Updates `GetDataAsync` and `GetStreamAsync` to throw `NotImplementedException`.	`src/BootstrapBlazor/Services/DefaultHtml2ImageService.cs`
Updates the Html2Images sample page to include a package tip and simplifies the export logic.	Adds a `PackageTips` component to suggest including the `BootstrapBlazor.Html2Image` package. Removes the style properties from the `Html2ImageOptions` when calling `GetDataAsync`.	`src/BootstrapBlazor.Server/Components/Samples/Html2Images.razor` `src/BootstrapBlazor.Server/Components/Samples/Html2Images.razor.cs`
Updates the `GetDataAsync` and `GetStreamAsync` methods in the `IHtml2Image` interface to accept an `IHtml2ImageOptions` interface.	Updates the `GetDataAsync` method signature. Updates the `GetStreamAsync` method signature.	`src/BootstrapBlazor/Services/IHtml2Image.cs`
Adds the `AddBootstrapBlazorHtml2ImageService` extension method to the service collection.	Adds `services.AddBootstrapBlazorHtml2ImageService()` to `AddBootstrapBlazorServices`.	`src/BootstrapBlazor.Server/Extensions/ServiceCollectionSharedExtensions.cs`
Adds an interface `IHtml2ImageOptions` for Html2Image options.	Adds properties for `Width`, `Height`, `BackgroundColor`, `CanvasWidth`, `CanvasHeight`, `IncludeStyleProperties`, `Quality`, `PixelRatio`, and `Type`.	`src/BootstrapBlazor/Services/IHtml2ImageOptions.cs`
Adds a unit test to verify that the `Html2Image` service throws an error when the package is not added.	Adds a test case `Html2Image_Error` that checks for `NotImplementedException` when calling `GetDataAsync` and `GetStreamAsync`.	`test/UnitTest/Services/Html2ImageServiceTest.cs`
Removes the `Html2ImageOptions` class.	Deletes the `Html2ImageOptions.cs` file.	`src/BootstrapBlazor/Options/Html2ImageOptions.cs`
Removes the javascript files related to the html2image library.	Deletes the `html-to-image.js` file. Deletes the `html2image.js` file.	`src/BootstrapBlazor/wwwroot/lib/html2image/html-to-image.js` `src/BootstrapBlazor/wwwroot/modules/html2image.js`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5425	Update the Html2Image extension package.	✅

Possibly linked issues

refactor(Html2Image): update Html2Image extension package #5425: The PR fixes the issue by updating the Html2Image extension package and removing unused code.
refactor(Html2Image): update Html2Image extension package #5425: The PR fixes the issue by updating the Html2Image extension package to resolve the missing cshtml files and restore SVG support.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider removing the try-catch blocks in the original DefaultHtml2ImageService as they are no longer needed.
The added test case is good for verifying the behavior of the service when the Html2Image package is not added.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

codecov · 2025-02-22T14:59:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0c035d2) to head (e676625).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #5426      +/-   ##
===========================================
+ Coverage   99.87%   100.00%   +0.12%     
===========================================
  Files         646       645       -1     
  Lines       29387     29351      -36     
  Branches     4135      4130       -5     
===========================================
+ Hits        29349     29351       +2     
+ Misses         38         0      -38

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ArgoZhang and others added 19 commits February 22, 2025 12:34

refactor: 更新配置类

3f5a603

refactor: 移除 html2image 实现

3733d04

test: 更新单元测试

580536b

test: 更新单元测试

02d82eb

refactor: 更改为接口

25ebb12

refactor: 更改为默认实现

db62a43

chore: 增加 Html2Image 服务

87425e3

refactor: 参数可为空

8f959a1

test: 更新单元测试

5b377da

refactor: 移除 html2image 脚本

735f073

Merge branch 'main' into refactor-image

0d0db26

refactor: 更新接口

8d677a6

doc: 精简代码

1352307

chore: bump version 9.3.1-beta32

55a66a2

Co-Authored-By: ElanCao <[email protected]>

refactor: 更新示例代码

a46433e

chore: 更新包版本

f748ca6

chore: 更新配置

00078ea

doc: 更新资源文件

c154224

doc: 更新文档

e676625

bb-auto bot assigned ArgoZhang Feb 22, 2025

bb-auto bot added the enhancement New feature or request label Feb 22, 2025

bb-auto bot added this to the v9.3.0 milestone Feb 22, 2025

ArgoZhang enabled auto-merge (squash) February 22, 2025 14:57

sourcery-ai bot approved these changes Feb 22, 2025

View reviewed changes

ArgoZhang merged commit cf9977e into main Feb 22, 2025
6 checks passed

ArgoZhang deleted the refactor-image branch February 22, 2025 14:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(Html2Image): update Html2Image extension package #5426

refactor(Html2Image): update Html2Image extension package #5426

Uh oh!

ArgoZhang commented Feb 22, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Feb 22, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

codecov bot commented Feb 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

refactor(Html2Image): update Html2Image extension package #5426

refactor(Html2Image): update Html2Image extension package #5426

Uh oh!

Conversation

ArgoZhang commented Feb 22, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

update Html2Image extension package

Description

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Feb 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ArgoZhang commented Feb 22, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 22, 2025 •

edited

Loading

codecov bot commented Feb 22, 2025 •

edited

Loading